<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>netmiko.fortinet.fortinet_ssh API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>netmiko.fortinet.fortinet_ssh</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">import paramiko
import re
from typing import Optional

from netmiko.no_config import NoConfig
from netmiko.cisco_base_connection import CiscoSSHConnection


class FortinetSSH(NoConfig, CiscoSSHConnection):
    def _modify_connection_params(self) -&gt; None:
        &#34;&#34;&#34;Modify connection parameters prior to SSH connection.&#34;&#34;&#34;
        paramiko_transport = getattr(paramiko, &#34;Transport&#34;)
        paramiko_transport._preferred_kex = (
            &#34;diffie-hellman-group14-sha1&#34;,
            &#34;diffie-hellman-group-exchange-sha1&#34;,
            &#34;diffie-hellman-group-exchange-sha256&#34;,
            &#34;diffie-hellman-group1-sha1&#34;,
        )

    def session_preparation(self) -&gt; None:
        &#34;&#34;&#34;Prepare the session after the connection has been established.&#34;&#34;&#34;

        data = self._test_channel_read(pattern=&#34;to accept|[#$]&#34;)
        # If &#34;set post-login-banner enable&#34; is set it will require you to press &#39;a&#39;
        # to accept the banner before you login. This will accept if it occurs
        if &#34;to accept&#34; in data:
            self.write_channel(&#34;a\r&#34;)
            self._test_channel_read(pattern=r&#34;[#$]&#34;)

        self.set_base_prompt(alt_prompt_terminator=&#34;$&#34;)
        self.disable_paging()

    def disable_paging(
        self,
        command: str = &#34;terminal length 0&#34;,
        delay_factor: Optional[float] = None,
        cmd_verify: bool = True,
        pattern: Optional[str] = None,
    ) -&gt; str:
        &#34;&#34;&#34;Disable paging is only available with specific roles so it may fail.&#34;&#34;&#34;
        check_command = &#34;get system status | grep Virtual&#34;
        output = self._send_command_timing_str(check_command)
        self.allow_disable_global = True
        self.vdoms = False
        self._output_mode = &#34;more&#34;

        if re.search(r&#34;Virtual domain configuration: (multiple|enable)&#34;, output):
            self.vdoms = True
            vdom_additional_command = &#34;config global&#34;
            output = self._send_command_timing_str(vdom_additional_command, last_read=3)
            if &#34;Command fail&#34; in output:
                self.allow_disable_global = False
                if self.remote_conn is not None:
                    self.remote_conn.close()
                self.establish_connection(width=100, height=1000)

        new_output = &#34;&#34;
        if self.allow_disable_global:
            self._retrieve_output_mode()
            disable_paging_commands = [
                &#34;config system console&#34;,
                &#34;set output standard&#34;,
                &#34;end&#34;,
            ]
            # There is an extra &#39;end&#39; required if in multi-vdoms are enabled
            if self.vdoms:
                disable_paging_commands.append(&#34;end&#34;)
            outputlist = [
                self._send_command_timing_str(command, last_read=3)
                for command in disable_paging_commands
            ]
            # Should test output is valid
            new_output = self.RETURN.join(outputlist)

        return output + new_output

    def _retrieve_output_mode(self) -&gt; None:
        &#34;&#34;&#34;Save the state of the output mode so it can be reset at the end of the session.&#34;&#34;&#34;
        reg_mode = re.compile(r&#34;output\s+:\s+(?P&lt;mode&gt;.*)\s+\n&#34;)
        output = self._send_command_str(&#34;get system console&#34;)
        result_mode_re = reg_mode.search(output)
        if result_mode_re:
            result_mode = result_mode_re.group(&#34;mode&#34;).strip()
            if result_mode in [&#34;more&#34;, &#34;standard&#34;]:
                self._output_mode = result_mode

    def cleanup(self, command: str = &#34;exit&#34;) -&gt; None:
        &#34;&#34;&#34;Re-enable paging globally.&#34;&#34;&#34;
        if self.allow_disable_global:
            # Return paging state
            output_mode_cmd = f&#34;set output {self._output_mode}&#34;
            enable_paging_commands = [&#34;config system console&#34;, output_mode_cmd, &#34;end&#34;]
            if self.vdoms:
                enable_paging_commands.insert(0, &#34;config global&#34;)
            # Should test output is valid
            for command in enable_paging_commands:
                self.send_command_timing(command)
        return super().cleanup(command=command)

    def save_config(
        self, cmd: str = &#34;&#34;, confirm: bool = False, confirm_response: str = &#34;&#34;
    ) -&gt; str:
        &#34;&#34;&#34;Not Implemented&#34;&#34;&#34;
        raise NotImplementedError</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="netmiko.fortinet.fortinet_ssh.FortinetSSH"><code class="flex name class">
<span>class <span class="ident">FortinetSSH</span></span>
<span>(</span><span>ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[<a title="netmiko.session_log.SessionLog" href="../session_log.html#netmiko.session_log.SessionLog">SessionLog</a>] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'utf-8', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False)</span>
</code></dt>
<dd>
<div class="desc"><p>Class for platforms that have no config mode.</p>
<p>check_config_mode returns True as the expectation is that configuration commands
can be executed directly. So in your current state, you are in "config mode" i.e.
you can make configuration changes.</p>
<p>If you truly cannot make any configuration changes to device then you should probably
overwrite check_config_mode in the platform specific driver and return False.</p>
<pre><code>    Initialize attributes for establishing connection to target device.

    :param ip: IP address of target device. Not required if &lt;code&gt;host&lt;/code&gt; is
        provided.

    :param host: Hostname of target device. Not required if &lt;code&gt;ip&lt;/code&gt; is
            provided.

    :param username: Username to authenticate against target device if
            required.

    :param password: Password to authenticate against target device if
            required.

    :param secret: The enable password if target device requires one.

    :param port: The destination port used to connect to the target
            device.

    :param device_type: Class selection based on device type.

    :param verbose: Enable additional messages to standard output.

    :param global_delay_factor: Multiplication factor affecting Netmiko delays (default: 1).

    :param use_keys: Connect to target device using SSH keys.

    :param key_file: Filename path of the SSH key file to use.

    :param pkey: SSH key object to use.

    :param passphrase: Passphrase to use for encrypted key; password will be used for key
            decryption if not specified.

    :param disabled_algorithms: Dictionary of SSH algorithms to disable. Refer to the Paramiko
            documentation for a description of the expected format.

    :param allow_agent: Enable use of SSH key-agent.

    :param ssh_strict: Automatically reject unknown SSH host keys (default: False, which
            means unknown SSH host keys will be accepted).

    :param system_host_keys: Load host keys from the users known_hosts file.

    :param alt_host_keys: If &lt;code&gt;True&lt;/code&gt; host keys will be loaded from the file specified in
            alt_key_file.

    :param alt_key_file: SSH host key file to use (if alt_host_keys=True).

    :param ssh_config_file: File name of OpenSSH configuration file.

    :param timeout: Connection timeout.

    :param session_timeout: Set a timeout for parallel requests.

    :param auth_timeout: Set a timeout (in seconds) to wait for an authentication response.

    :param banner_timeout: Set a timeout to wait for the SSH banner (pass to Paramiko).

    :param keepalive: Send SSH keepalive packets at a specific interval, in seconds.
            Currently defaults to 0, for backwards compatibility (it will not attempt
            to keep the connection alive).

    :param default_enter: Character(s) to send to correspond to enter key (default:
</code></pre>
<p>).</p>
<pre><code>    :param response_return: Character(s) to use in normalized return data to represent
            enter key (default:
</code></pre>
<p>)</p>
<pre><code>    :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor
            to select smallest of global and specific. Sets default global_delay_factor to .1
            (default: True)

    :param session_log: File path or BufferedIOBase subclass object to write the session log to.

    :param session_log_record_writes: The session log generally only records channel reads due
            to eliminate command duplication due to command echo. You can enable this if you
            want to record both channel reads and channel writes in the log (default: False).

    :param session_log_file_mode: "write" or "append" for session_log file mode
            (default: "write")

    :param allow_auto_change: Allow automatic configuration changes for terminal settings.
            (default: False)

    :param encoding: Encoding to be used when writing bytes to the output channel.
            (default: ascii)

    :param sock: An open socket or socket-like object (such as a &lt;code&gt;.Channel&lt;/code&gt;) to use for
            communication to the target host (default: None).

    :param global_cmd_verify: Control whether command echo verification is enabled or disabled
            (default: None). Global attribute takes precedence over function &lt;code&gt;cmd\_verify&lt;/code&gt;
            argument. Value of &lt;code&gt;None&lt;/code&gt; indicates to use function &lt;code&gt;cmd\_verify&lt;/code&gt; argument.

    :param auto_connect: Control whether Netmiko automatically establishes the connection as
            part of the object creation (default: True).

    :param delay_factor_compat: Set send_command and send_command_timing back to using Netmiko
            3.x behavior for delay_factor/global_delay_factor/max_loops. This argument will be
            eliminated in Netmiko 5.x (default: False).
</code></pre></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class FortinetSSH(NoConfig, CiscoSSHConnection):
    def _modify_connection_params(self) -&gt; None:
        &#34;&#34;&#34;Modify connection parameters prior to SSH connection.&#34;&#34;&#34;
        paramiko_transport = getattr(paramiko, &#34;Transport&#34;)
        paramiko_transport._preferred_kex = (
            &#34;diffie-hellman-group14-sha1&#34;,
            &#34;diffie-hellman-group-exchange-sha1&#34;,
            &#34;diffie-hellman-group-exchange-sha256&#34;,
            &#34;diffie-hellman-group1-sha1&#34;,
        )

    def session_preparation(self) -&gt; None:
        &#34;&#34;&#34;Prepare the session after the connection has been established.&#34;&#34;&#34;

        data = self._test_channel_read(pattern=&#34;to accept|[#$]&#34;)
        # If &#34;set post-login-banner enable&#34; is set it will require you to press &#39;a&#39;
        # to accept the banner before you login. This will accept if it occurs
        if &#34;to accept&#34; in data:
            self.write_channel(&#34;a\r&#34;)
            self._test_channel_read(pattern=r&#34;[#$]&#34;)

        self.set_base_prompt(alt_prompt_terminator=&#34;$&#34;)
        self.disable_paging()

    def disable_paging(
        self,
        command: str = &#34;terminal length 0&#34;,
        delay_factor: Optional[float] = None,
        cmd_verify: bool = True,
        pattern: Optional[str] = None,
    ) -&gt; str:
        &#34;&#34;&#34;Disable paging is only available with specific roles so it may fail.&#34;&#34;&#34;
        check_command = &#34;get system status | grep Virtual&#34;
        output = self._send_command_timing_str(check_command)
        self.allow_disable_global = True
        self.vdoms = False
        self._output_mode = &#34;more&#34;

        if re.search(r&#34;Virtual domain configuration: (multiple|enable)&#34;, output):
            self.vdoms = True
            vdom_additional_command = &#34;config global&#34;
            output = self._send_command_timing_str(vdom_additional_command, last_read=3)
            if &#34;Command fail&#34; in output:
                self.allow_disable_global = False
                if self.remote_conn is not None:
                    self.remote_conn.close()
                self.establish_connection(width=100, height=1000)

        new_output = &#34;&#34;
        if self.allow_disable_global:
            self._retrieve_output_mode()
            disable_paging_commands = [
                &#34;config system console&#34;,
                &#34;set output standard&#34;,
                &#34;end&#34;,
            ]
            # There is an extra &#39;end&#39; required if in multi-vdoms are enabled
            if self.vdoms:
                disable_paging_commands.append(&#34;end&#34;)
            outputlist = [
                self._send_command_timing_str(command, last_read=3)
                for command in disable_paging_commands
            ]
            # Should test output is valid
            new_output = self.RETURN.join(outputlist)

        return output + new_output

    def _retrieve_output_mode(self) -&gt; None:
        &#34;&#34;&#34;Save the state of the output mode so it can be reset at the end of the session.&#34;&#34;&#34;
        reg_mode = re.compile(r&#34;output\s+:\s+(?P&lt;mode&gt;.*)\s+\n&#34;)
        output = self._send_command_str(&#34;get system console&#34;)
        result_mode_re = reg_mode.search(output)
        if result_mode_re:
            result_mode = result_mode_re.group(&#34;mode&#34;).strip()
            if result_mode in [&#34;more&#34;, &#34;standard&#34;]:
                self._output_mode = result_mode

    def cleanup(self, command: str = &#34;exit&#34;) -&gt; None:
        &#34;&#34;&#34;Re-enable paging globally.&#34;&#34;&#34;
        if self.allow_disable_global:
            # Return paging state
            output_mode_cmd = f&#34;set output {self._output_mode}&#34;
            enable_paging_commands = [&#34;config system console&#34;, output_mode_cmd, &#34;end&#34;]
            if self.vdoms:
                enable_paging_commands.insert(0, &#34;config global&#34;)
            # Should test output is valid
            for command in enable_paging_commands:
                self.send_command_timing(command)
        return super().cleanup(command=command)

    def save_config(
        self, cmd: str = &#34;&#34;, confirm: bool = False, confirm_response: str = &#34;&#34;
    ) -&gt; str:
        &#34;&#34;&#34;Not Implemented&#34;&#34;&#34;
        raise NotImplementedError</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="netmiko.no_config.NoConfig" href="../no_config.html#netmiko.no_config.NoConfig">NoConfig</a></li>
<li><a title="netmiko.cisco_base_connection.CiscoSSHConnection" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoSSHConnection">CiscoSSHConnection</a></li>
<li><a title="netmiko.cisco_base_connection.CiscoBaseConnection" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection">CiscoBaseConnection</a></li>
<li><a title="netmiko.base_connection.BaseConnection" href="../base_connection.html#netmiko.base_connection.BaseConnection">BaseConnection</a></li>
</ul>
<h3>Methods</h3>
<dl>
<dt id="netmiko.fortinet.fortinet_ssh.FortinetSSH.cleanup"><code class="name flex">
<span>def <span class="ident">cleanup</span></span>(<span>self, command: str = 'exit') ‑> None</span>
</code></dt>
<dd>
<div class="desc"><p>Re-enable paging globally.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def cleanup(self, command: str = &#34;exit&#34;) -&gt; None:
    &#34;&#34;&#34;Re-enable paging globally.&#34;&#34;&#34;
    if self.allow_disable_global:
        # Return paging state
        output_mode_cmd = f&#34;set output {self._output_mode}&#34;
        enable_paging_commands = [&#34;config system console&#34;, output_mode_cmd, &#34;end&#34;]
        if self.vdoms:
            enable_paging_commands.insert(0, &#34;config global&#34;)
        # Should test output is valid
        for command in enable_paging_commands:
            self.send_command_timing(command)
    return super().cleanup(command=command)</code></pre>
</details>
</dd>
<dt id="netmiko.fortinet.fortinet_ssh.FortinetSSH.disable_paging"><code class="name flex">
<span>def <span class="ident">disable_paging</span></span>(<span>self, command: str = 'terminal length 0', delay_factor: Optional[float] = None, cmd_verify: bool = True, pattern: Optional[str] = None) ‑> str</span>
</code></dt>
<dd>
<div class="desc"><p>Disable paging is only available with specific roles so it may fail.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def disable_paging(
    self,
    command: str = &#34;terminal length 0&#34;,
    delay_factor: Optional[float] = None,
    cmd_verify: bool = True,
    pattern: Optional[str] = None,
) -&gt; str:
    &#34;&#34;&#34;Disable paging is only available with specific roles so it may fail.&#34;&#34;&#34;
    check_command = &#34;get system status | grep Virtual&#34;
    output = self._send_command_timing_str(check_command)
    self.allow_disable_global = True
    self.vdoms = False
    self._output_mode = &#34;more&#34;

    if re.search(r&#34;Virtual domain configuration: (multiple|enable)&#34;, output):
        self.vdoms = True
        vdom_additional_command = &#34;config global&#34;
        output = self._send_command_timing_str(vdom_additional_command, last_read=3)
        if &#34;Command fail&#34; in output:
            self.allow_disable_global = False
            if self.remote_conn is not None:
                self.remote_conn.close()
            self.establish_connection(width=100, height=1000)

    new_output = &#34;&#34;
    if self.allow_disable_global:
        self._retrieve_output_mode()
        disable_paging_commands = [
            &#34;config system console&#34;,
            &#34;set output standard&#34;,
            &#34;end&#34;,
        ]
        # There is an extra &#39;end&#39; required if in multi-vdoms are enabled
        if self.vdoms:
            disable_paging_commands.append(&#34;end&#34;)
        outputlist = [
            self._send_command_timing_str(command, last_read=3)
            for command in disable_paging_commands
        ]
        # Should test output is valid
        new_output = self.RETURN.join(outputlist)

    return output + new_output</code></pre>
</details>
</dd>
<dt id="netmiko.fortinet.fortinet_ssh.FortinetSSH.save_config"><code class="name flex">
<span>def <span class="ident">save_config</span></span>(<span>self, cmd: str = '', confirm: bool = False, confirm_response: str = '') ‑> str</span>
</code></dt>
<dd>
<div class="desc"><p>Not Implemented</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def save_config(
    self, cmd: str = &#34;&#34;, confirm: bool = False, confirm_response: str = &#34;&#34;
) -&gt; str:
    &#34;&#34;&#34;Not Implemented&#34;&#34;&#34;
    raise NotImplementedError</code></pre>
</details>
</dd>
<dt id="netmiko.fortinet.fortinet_ssh.FortinetSSH.session_preparation"><code class="name flex">
<span>def <span class="ident">session_preparation</span></span>(<span>self) ‑> None</span>
</code></dt>
<dd>
<div class="desc"><p>Prepare the session after the connection has been established.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def session_preparation(self) -&gt; None:
    &#34;&#34;&#34;Prepare the session after the connection has been established.&#34;&#34;&#34;

    data = self._test_channel_read(pattern=&#34;to accept|[#$]&#34;)
    # If &#34;set post-login-banner enable&#34; is set it will require you to press &#39;a&#39;
    # to accept the banner before you login. This will accept if it occurs
    if &#34;to accept&#34; in data:
        self.write_channel(&#34;a\r&#34;)
        self._test_channel_read(pattern=r&#34;[#$]&#34;)

    self.set_base_prompt(alt_prompt_terminator=&#34;$&#34;)
    self.disable_paging()</code></pre>
</details>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="netmiko.cisco_base_connection.CiscoSSHConnection" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoSSHConnection">CiscoSSHConnection</a></b></code>:
<ul class="hlist">
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.check_config_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.check_config_mode">check_config_mode</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.check_enable_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.check_enable_mode">check_enable_mode</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.clear_buffer" href="../base_connection.html#netmiko.base_connection.BaseConnection.clear_buffer">clear_buffer</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.commit" href="../base_connection.html#netmiko.base_connection.BaseConnection.commit">commit</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.config_mode" href="../base_connection.html#netmiko.base_connection.BaseConnection.config_mode">config_mode</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.disconnect" href="../base_connection.html#netmiko.base_connection.BaseConnection.disconnect">disconnect</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.enable" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.enable">enable</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.establish_connection" href="../base_connection.html#netmiko.base_connection.BaseConnection.establish_connection">establish_connection</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.exit_config_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.exit_config_mode">exit_config_mode</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.exit_enable_mode" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.exit_enable_mode">exit_enable_mode</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.find_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.find_prompt">find_prompt</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.is_alive" href="../base_connection.html#netmiko.base_connection.BaseConnection.is_alive">is_alive</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.normalize_cmd" href="../base_connection.html#netmiko.base_connection.BaseConnection.normalize_cmd">normalize_cmd</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.normalize_linefeeds" href="../base_connection.html#netmiko.base_connection.BaseConnection.normalize_linefeeds">normalize_linefeeds</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.paramiko_cleanup" href="../base_connection.html#netmiko.base_connection.BaseConnection.paramiko_cleanup">paramiko_cleanup</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.read_channel" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_channel">read_channel</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.read_channel_timing" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_channel_timing">read_channel_timing</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.read_until_pattern" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_until_pattern">read_until_pattern</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.read_until_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_until_prompt">read_until_prompt</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.read_until_prompt_or_pattern" href="../base_connection.html#netmiko.base_connection.BaseConnection.read_until_prompt_or_pattern">read_until_prompt_or_pattern</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.run_ttp" href="../base_connection.html#netmiko.base_connection.BaseConnection.run_ttp">run_ttp</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.select_delay_factor" href="../base_connection.html#netmiko.base_connection.BaseConnection.select_delay_factor">select_delay_factor</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.send_command" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_command">send_command</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.send_command_expect" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_command_expect">send_command_expect</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.send_command_timing" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_command_timing">send_command_timing</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.send_config_from_file" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_config_from_file">send_config_from_file</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.send_config_set" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_config_set">send_config_set</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.send_multiline" href="../base_connection.html#netmiko.base_connection.BaseConnection.send_multiline">send_multiline</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.set_base_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.set_base_prompt">set_base_prompt</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.set_terminal_width" href="../base_connection.html#netmiko.base_connection.BaseConnection.set_terminal_width">set_terminal_width</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.special_login_handler" href="../base_connection.html#netmiko.base_connection.BaseConnection.special_login_handler">special_login_handler</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.strip_ansi_escape_codes" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_ansi_escape_codes">strip_ansi_escape_codes</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.strip_backspaces" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_backspaces">strip_backspaces</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.strip_command" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_command">strip_command</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.strip_prompt" href="../base_connection.html#netmiko.base_connection.BaseConnection.strip_prompt">strip_prompt</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.telnet_login" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoBaseConnection.telnet_login">telnet_login</a></code></li>
<li><code><a title="netmiko.cisco_base_connection.CiscoSSHConnection.write_channel" href="../base_connection.html#netmiko.base_connection.BaseConnection.write_channel">write_channel</a></code></li>
</ul>
</li>
</ul>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="netmiko.fortinet" href="index.html">netmiko.fortinet</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="netmiko.fortinet.fortinet_ssh.FortinetSSH" href="#netmiko.fortinet.fortinet_ssh.FortinetSSH">FortinetSSH</a></code></h4>
<ul class="">
<li><code><a title="netmiko.fortinet.fortinet_ssh.FortinetSSH.cleanup" href="#netmiko.fortinet.fortinet_ssh.FortinetSSH.cleanup">cleanup</a></code></li>
<li><code><a title="netmiko.fortinet.fortinet_ssh.FortinetSSH.disable_paging" href="#netmiko.fortinet.fortinet_ssh.FortinetSSH.disable_paging">disable_paging</a></code></li>
<li><code><a title="netmiko.fortinet.fortinet_ssh.FortinetSSH.save_config" href="#netmiko.fortinet.fortinet_ssh.FortinetSSH.save_config">save_config</a></code></li>
<li><code><a title="netmiko.fortinet.fortinet_ssh.FortinetSSH.session_preparation" href="#netmiko.fortinet.fortinet_ssh.FortinetSSH.session_preparation">session_preparation</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>